Granular Workflow
==========================

.. note:: Feature requires a `Momentum Granular <https://www.algoryx.se/momentum-granular/>`_ license.

.. _granular_workflow:

The workflow for Algoryx Momentum with the **Granular** addon can briefly be described as:

1. Import/Create your CAD model in SpaceClaim.
2. :ref:`activate` the add-in.
3. Use the :ref:`simulation_structure` to organize the simulation model in relation to the moving parts.
4. Either use :ref:`ribbon_detect_joints` to automatically detect "peg-in-a-hole" joints, or manually attach joints between moving parts (rigid bodies) where desired.
5. Set the initial values for :ref:`rigid body properties <rigid_body_properties>`, :ref:`joint properties <joints>` and :ref:`material settings <ribbon_material_pairs>`.
6. (Optional) set up your control sequences for joints using the :ref:`ribbon_sequence_editor`.
7. Activate granular in :ref:`Granular Ribbon <granular_ribbon_menu>`. This adds a granular body system object to the scene.
8. Setup emitters and sensor in the :ref:`Granular Ribbon <granular_ribbon_menu>` to solids in the scene which are active in the simulation.
9. Setup models for the :ref:`Granular <granular>` flow using :ref:`Rigid Body distributons <body_distribution_editor>` via :ref:`Templates <template_tool>` or :ref:`Particle distributions <particle_editor>`.
10. Specify the duration and the simulation frequency of your simulation in the :ref:`simulation_settings`.
11. Configure the :ref:`appropriate solver settings <setting_solver_iterations>` that are dependent on the characteristics of the granular system.
12. :ref:`Simulate the system <ribbon_simulation>`.
13. Replay the simulation with the :ref:`playback_tab`. Specify the play back speed to replay in slow motion.
14. Once the primary setup is done the scene can be scaled up and executed in an :ref:`external environment <external_simulation>`, which can take some minutes or hours depending on scene size.
15. While the external simulation is computing, the user can continue working inside SpaceClaim.
16. Once the large simulation is done, open the :ref:`Journal Viewer <journal_viewer>`. from within SpaceClaim and load the resulting journal for post-processing.


--------------------------------
External Simulation
--------------------------------

When using large sets of granular material, the computational effort can be improved using an external simulation environment.
See :ref:`External Simulation <external_simulation>`. External journal files is created from the simulations, outside the SpaceClaim environment.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Post processing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The produced journal files from an external simulation are primary processed by the :ref:`Journal Viewer <journal_viewer>`.
Post processing is done on journals that are created using :ref:`External Simulation <external_simulation>`.